Configs for Code Scrawl

To know:

• Configs go in PROJECT_ROOT/.scrawl.json or PROJECT_ROOT/.config/scrawl.json
• In cli scrawl --boolAttribute or scrawl -strAttribute strValue to override your json configurations.
  • --boolAttribute presence means "set boolAttribute to true"
• Your .json file is loaded by Tlf\Cli (when you use the scrawl command). If you instantiate Tlf\Scrawl($projectDir, $configs) in PHP, you'd have to load up configs yourself.
• --deleteExistingDocs is a DANGEROUS feature. If true in your .json or provided in your scrawl call, your entire docs folder will be deleted when running scrawl.
• Configs in the PHP array provided to Tlf\Scrawl do NOT use - or --. This is purely for predictable cli input parsing.
• --markdown.preserveNewLines Adds 2 spaces at the end of every line to ensure Markdown parsers separate those lines in output.
  • Defaults true... thus MUST be disabled through .json
• There's also a -scrawl.ext config option to load additional extensions. See the config file for this package for an example.
  • @TODO properly document -scrawl.ext config.

Available configs & their default values:

All default values are determined/picked in the Tlf\Cli class

• dir.docs: docs or doc or doc
• dir.template: docs-src or doc-src or docs-src
• dir.code: src or code or src
• file.conf: .config/scrawl.json or .scrawl.json or .config/scrawl.json
• file.code.ext: *
• file.template.ext: .src.md
• deleteExistingDocs: false
• markdown.preserveNewLines: true
• markdown.prependGenNotice: true
• scrawl.ext: []
• readme.copyFromDocs: true